Compose GLFW/dev.sargunv.composeglfw

Package-level declarations

Types

@Stable

data class Direct3DRenderContext(val directContext: DirectContext, val hwnd: Long, val adapter: Long, val device: Long, val commandQueue: Long, val swapChain: Long, val compositionDevice: Long, val compositionTarget: Long, val compositionVisual: Long) : RenderContext

Direct3D render context for a Compose GLFW window.

DisplayServer

enum DisplayServer : Enum<DisplayServer>

Display server used by GLFW for a window.

DroppedFiles

data class DroppedFiles(val paths: List<Path>)

Files dropped onto a Compose GLFW window.

FileDialogFilter

data class FileDialogFilter(val name: String, val extensions: List<String>)

File type filter shown by native file pickers.

FilePicker

interface FilePicker

Native file and folder picker for a Compose GLFW window.

HostWindow

interface HostWindow

Current host window.

HostWindowInfo

data class HostWindowInfo(val displayServer: DisplayServer, val displayName: String?, val renderBackend: RenderBackend, val framebufferWidth: Int, val framebufferHeight: Int, val windowWidth: Int, val windowHeight: Int, val contentScale: Float)

Current host window, display, and renderer information.

HostWindowScope

interface HostWindowScope

Values available to content hosted in a GLFW window.

MetalRenderContext

data class MetalRenderContext(val directContext: DirectContext, val view: Long, val layer: Long, val device: Long, val queue: Long) : RenderContext

Metal render context for a Compose GLFW window.

OpenGlRenderContext

data class OpenGlRenderContext(val directContext: DirectContext, val eglDisplay: Long, val eglConfig: Long, val eglContext: Long, val getProcAddress: Long, val resolveProcAddress: (String) -> Long, val makeCurrent: () -> Unit) : RenderContext

OpenGL render context for a Compose GLFW window.

RenderBackend

enum RenderBackend : Enum<RenderBackend>

Renderer used to draw Compose content.

RenderContext

sealed interface RenderContext

Backend-specific render context for a hosted Compose window.

TextToolbarActions

interface TextToolbarActions

Actions that custom text toolbar content can perform.

TextToolbarContent

typealias TextToolbarContent = @Composable (state: TextToolbarState, actions: TextToolbarActions) -> Unit

Composable content used to show text editing actions.

TextToolbarState

data class TextToolbarState(val rect: Rect, val canCopy: Boolean, val canPaste: Boolean, val canCut: Boolean, val canSelectAll: Boolean, val canAutofill: Boolean)

State passed to custom text toolbar content.

WindowOptions

class WindowOptions

Host-specific options used when creating a GLFW window.

WindowPlacement

enum WindowPlacement : Enum<WindowPlacement>

Describes how a window is placed on the screen.

WindowPosition

@Immutable

sealed class WindowPosition

Position of a window on screen in Dp.

WindowState

@Stable

interface WindowState

Runtime state for a GLFW window.

Properties

LocalWindow

val LocalWindow: ProvidableCompositionLocal<HostWindow>

Current Compose GLFW window.

Functions

cursorImagePointerIcon

fun cursorImagePointerIcon(image: ImageBitmap, imageScale: Float, hotSpot: IntOffset = IntOffset.Zero): PointerIcon

Creates a pointer icon from an image.

droppedFilesOrNull

fun DragAndDropEvent.droppedFilesOrNull(): DroppedFiles?

Returns the dropped files carried by this event, or null if it is not a file drop event.

fileDropTarget

fun Modifier.fileDropTarget(accept: (DroppedFiles) -> Boolean = { true }, onStarted: (DroppedFiles) -> Unit = {}, onEntered: (DroppedFiles) -> Unit = {}, onMoved: (DroppedFiles) -> Unit = {}, onExited: (DroppedFiles) -> Unit = {}, onChanged: (DroppedFiles) -> Unit = {}, onEnded: (DroppedFiles) -> Unit = {}, onDrop: (DroppedFiles) -> Unit): Modifier

Adds a file drop target to this modifier chain.

glfwApplication

fun glfwApplication(content: @Composable ApplicationScope.() -> Unit)

Starts a Compose GLFW application and runs until the application exits.

rememberWindowState

@Composable

fun rememberWindowState(placement: WindowPlacement = WindowPlacement.Floating, isMinimized: Boolean = false, position: WindowPosition = WindowPosition.PlatformDefault, size: DpSize = DpSize(800.dp, 600.dp)): WindowState

Creates a WindowState that is remembered across compositions.

Window

@Composable

fun ApplicationScope.Window(onCloseRequest: () -> Unit, state: WindowState = rememberWindowState(), visible: Boolean = true, title: String = "Untitled", undecorated: Boolean = false, transparent: Boolean = false, resizable: Boolean = true, enabled: Boolean = true, focusOnShow: Boolean = true, alwaysOnTop: Boolean = false, onPreviewKeyEvent: (KeyEvent) -> Boolean = { false }, onKeyEvent: (KeyEvent) -> Boolean = { false }, options: WindowOptions = WindowOptions(), content: @Composable HostWindowScope.() -> Unit)

Composes a GLFW window in the current application composition.

WindowPosition

fun WindowPosition(alignment: Alignment): WindowPosition

Constructs an aligned WindowPosition.

fun WindowPosition(x: Dp, y: Dp): WindowPosition

Constructs an absolute WindowPosition from x and y.

WindowState

fun WindowState(placement: WindowPlacement = WindowPlacement.Floating, isMinimized: Boolean = false, position: WindowPosition = WindowPosition.PlatformDefault, size: DpSize = DpSize(800.dp, 600.dp)): WindowState

Creates a state object that can be hoisted to control and observe window attributes.